Usage Item Interface Table

This extract file interface handles the usageClosed The consumption of services, for example a subscriber using call minutes. item (itemised breakdown) records belonging to the invoices in the extract set.

This extract file will contain a record for each charge line sub item, such as a phone call, associated with invoice lines in the current extract set.

Data loaded via this interface is primarily bound for the USAGE_ITEM CXPClosed Customer Experience Platform, or CXP, is MDS Global's self-service app that allows business customers to manage their own accounts and subscriptions. Admin schema table.

External table name

Schema

Mapped file

usage_item_Interface

Staging

usage_item.dat

 

Usage item interface table fields

Column Heading

Type

Length

Description

EXTERNAL_USAGE_ITEM_ID

VarChar2

40

This value is used for reference with the inclusive usage data within the current extract. It must be unique within the extract, but is preferably unique to the usage item within the CRM.
EXTERNAL _INVOICE_ID VarChar2 40 The CRM derived identifier of the invoice to which the current usage item line belongs.
EXTERNAL_ INVOICE_LINE_ID VarChar2 40 CRM derived identifier for the current invoice line to which the current usage item line belongs.
EXTERNAL_ORGANISATION_UNIT_ID VarChar2 40 Unique identifier denoting the CRM name for the organisation unit that owns the current invoice line.
ORGANISATION_UNIT_LEVEL Integer   The level within the organisation unit hierarchy, at which the current organisation unit resides.
USAGE_ITEM_DESCRIPTION VarChar2 100 A textual description of the current usage item. As standard, for telecoms call data, CXP takes this to be the number dialled.
USAGE_ITEM_START_DATE_TIME

Date

   The date and time on which the current usage charge began. DATE_FORMAT DATE MASK "yyyymmddhh24miss
USAGE_ITEM_END_DATE_TIME Date   The date and time on which the current usage charge ended. DATE_FORMAT DATE MASK "yyyymmddhh24miss"
GROSS_QUANTITY Integer   The total number of billable units consumed by the current usage record.
INCLUSIVE_QUANTITY Integer   The number of billable units of the current usage record absorbed by an inclusive usage allocation (i.e. the units discounted from the gross quantity prior to rating).
BILLED_QUANTITY Integer   The number of units of the current usage record actually rated and billed.
UNIT_OF_MEASURE VarChar2 40 The unit of measure that qualifies the gross, inclusive and billed quantity.
UNIT_OF_MEASURE_CATEGORY VarChar2 40 The categorisation for the unit of measure used on the current record. It allows records to be grouped together for reporting purposes. for example, inclusion of all charges that have a particular unit of measure category. Note: The unit of measure and unit of measure category combination given must be one of the valid combinations configured within the CXP database. Note: It is possible for any particular unit of measure value to be used in conjunction with different unit of measure categories (it is not a one to one relationship). The category supplied acts to place a record in that category for reporting and analysis.
GROSS_VALUE NUMBER (14,4) The total monetary value of the current usage record before any inclusive bundles and discounts are applied.
INCLUSIVE_VALUE NUMBER (14,4) The monetary value of the current usage record absorbed by an inclusive usage bundle allocation. Store as a positive value.
DISCOUNT_VALUE NUMBER (14,4) The monetary value of discounts applied to the current usage record. Store as a positive value.
BILLED_VALUE NUMBER (14,4) The billed monetary value of the current usage item record after any inclusive bundles and discounts have been applied. Billed value = gross value – inclusive value – discount value
CUSTOMER_COST_CENTRE VarChar2 40 An identifier allowing the charges from the current usage record to be attributed to a division within a business organisation. Optional.
INCLUSIVE_USAGE_STATUS VarChar2 40 Text description describing how inclusive usage schemes have operated on the current usage item. Optional.
TAX_CHARGED Number   '1' (Yes/True) or '0' (No/False). Is this usage item subject to taxation? Optional.
ATTRIBUTE_1 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_2 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_3 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_4 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_5 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_6 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_7 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_8 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_9 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ATTRIBUTE_10 VarChar2 40 Customisable usage item data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP.
ITEM_TYPE VarChar2 100 Used to apply a type to the usage item to differentiate it for reporting purposes (e.g. for report inclusion, exclusion, sorting and grouping).